(3) core array, function, tuple, sys: Add Scaladoc for undocumented entities - #26669
Draft
bvenners wants to merge 1 commit into
Draft
(3) core array, function, tuple, sys: Add Scaladoc for undocumented entities#26669bvenners wants to merge 1 commit into
bvenners wants to merge 1 commit into
Conversation
cheeseng
suggested changes
Aug 3, 2026
| @annotation.unspecialized def tupled: ((T1, T2, T3, T4, T5, T6, T7)) => R = { | ||
| case ((x1, x2, x3, x4, x5, x6, x7)) => apply(x1, x2, x3, x4, x5, x6, x7) | ||
| } | ||
| /** TODO FILL IN */ |
Contributor
There was a problem hiding this comment.
Not sure how this is missed, but I think this needs to be filled in.
|
|
||
| import scala.language.`2.13` | ||
|
|
||
| /** TODO FILL IN |
Contributor
There was a problem hiding this comment.
Not sure how this is missed, but I think these needs to be filled in.
|
|
||
| import scala.language.`2.13` | ||
|
|
||
| /** A base class for zero-parameter function implementations, allowing a function |
Contributor
There was a problem hiding this comment.
Shall we include the type parameter R also?
|
|
||
| import scala.language.`2.13` | ||
|
|
||
| /** A base class for one-parameter function implementations, allowing a function |
Contributor
There was a problem hiding this comment.
Shall we include the type parameter T1 and R also?
|
|
||
| import scala.language.`2.13` | ||
|
|
||
| /** A base class for two-parameter function implementations, allowing a function |
Contributor
There was a problem hiding this comment.
Shall we include type parameter T1, T2 and R?
| * exception once every line has been yielded if the exit code is non-zero | ||
| */ | ||
| def lazyLines(log: ProcessLogger, capacity: Integer): LazyList[String] = lazyLines(withInput = false, nonZeroException = true, Some(log), capacity) | ||
| /** Returns the standard output of the process represented by this builder as a `LazyList` |
Contributor
| * no exception. | ||
| */ | ||
| def lazyLines_!(capacity: Integer) : LazyList[String] = lazyLines(withInput = false, nonZeroException = false, None, capacity) | ||
| /** Returns the standard output of the process represented by this builder as a `LazyList` |
Contributor
|
|
||
| object Function1 { | ||
|
|
||
| /** Provides the [[UnliftOps.unlift]] method on functions that return an [[scala.Option]]. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR fills in a main doc comment plus @PARAM, @tparam, and @return tags for core array, function, tuple, and sys classes that are completely missing any Scaladoc documentation. I'm submitting it as a draft PR so that I can get the CI to run on it, to see if it breaks anything, and to start getting feedback. We automated the generation of these changes and have not reviewed all of them yet. We will review them all before making the PR non-draft. Please let me know whether you think this is going in the right direction in general, and anything specific that you notice that could be improved.